Blog - LINE ENGINEERING

TAG ARCHIVES: Technical Writing

사내 용어 사전, LINE Words 오픈 여정기
강정일2022-05-27
LINE 기술 문서 작성 및 관리 업무를 맡고 있는 Technical Writer 강정일입니다.
안녕하세요. LINE에서 근무하고 있는 테크니컬 라이터 강정일입니다. 혹시, MTG라는 말을 들어본 적 있으신가요? Google에서 검색해 보니 매직 더 개더링(Magic: The Gathering)이라는 게임이 제일 먼저 나오네요. 그런데 이 말을 LINE에서는 회의(meeting)를 의미하는 말로 많이 사용합니다. 일본 문화에 익숙하시거나 일본 분들과 협업해 보셨다면 이 말을 들어보셨을 수 있을 것 같은데요. 저는 이 표현을 LINE에서 처음 접했습니다. 그런데 LINE에만 이런 말이 있을까요? 대부분의 회사나 특정 분야에 속한 집단에는 그곳에서만 쓰는 말이 있기 마련입니다. 새로 그 집단에 합류한 사람은 그런 말을 익히는데 시간과 노력을 들여야겠죠. 제가 이런 이야기를 하는 이유는 최근 LINE에서 사내용 용어 사전을 오픈했기 때문입니다. 이번 글에서는 저희 팀에서 이 용어 사전을 만든 과정을 공유하려고 합니다. 배경 - 왜 만들게 되었나? 직무
- Technical Writing
C4 모델과 C4-PlantUML을 이용한 소프트웨어 구조 다이어그램 만들기
강정일2021-01-25
LINE 기술 문서 작성 및 관리 업무를 맡고 있는 Technical Writer 강정일입니다.
안녕하세요. LINE에서 테크니컬 라이터로 일하고 있는 강정일입니다. 모두 건강하게 잘 지내고 계신가요? 올해는 '새해 복 많이 받으세요.'라는 말보다 COVID-19 때문에 건강을 먼저 여쭙게 되는 것 같습니다. COVID-19로 많은 것이 변하면서 컨퍼런스 행사도 대부분 오프라인에서 온라인으로 변경해 진행되고 있습니다. 제가 이전에 방문기를 작성했던 Write the Docs 컨퍼런스도 2020년엔 온라인으로 진행되어 원격으로 시청했습니다. 이번 글에선 Write the Docs Portland 2020 온라인 발표 중 하나를 소개하고 이 내용에 대해 이야기해볼까 합니다. 발표 내용과 제 생각을 공유하기 전에 소프트웨어 구조 다이어그램에 대한 경험을 함께 떠올려 보면 좋을 것 같습니다. 소프트웨어 구조를 파악할 때 글보다는 소프트웨어 구조 다이어그램과 같은 그림을 통해 훨씬 빠르게 이해한 경험이
- Technical Writing
그것이 알고 싶다 - 왜 개발자는 글을 못 쓸까?
수J2020-12-22
LINE에서 즐겁게 일하고 있는 테크니컬 라이터입니다
개발자는 글을 못 쓰는 것일까? 아니, 개발자는 글을 안 쓰는 것일까? 아니, 개발자는 글을 쓰기 싫은 것일까? 물론 글을 잘 쓰는 개발자도 계시고 책을 집필한 개발자도, 잡지에 글을 기고하는 개발자도 계십니다. 저는 지금 모든 개발자가 글을 못 쓴다고 말하려는 것은 아닙니다. 어쩌면, 막상 쓰면 잘 쓸 수 있는데 글을 쓰겠다고 마음을 먹고 열 손가락을 키보드 자판 위에 살포시 올려놓기까지가 오래 걸리는 것일 수도 있습니다. 저는 현직 테크니컬 라이터이자 전직 개발자로서 현장에서 겪은 경험을 바탕으로 이 현상을 심층 분석해 보려고 합니다. 단, 분석만입니다. 마치 매년 12월~1월에 서점에서 만나볼 수 있는 다양한 자기 계발서 마냥 상당히 이론적인 내용을 나눕니다. 누군가에겐 매우 따분한 이야기가 될 수 있겠지요. 누구나 머리로는 알고 있는 내용이지만 실천으로 이어질 가능성이 현저히 낮은 내용 말입니다. 하지만 여러분, 이
- Technical Writing
주석 분석기를 이용한 간단한 API 문서화 방법
전정은2020-06-19
LINE에서 문서 솔루션 및 기술 문서 작성 기법을 고민하는 도큐먼트 엔지니어입니다.
테크니컬 라이터로서 가장 재미있는 순간은 바로 새로운 프로젝트를 시작할 때입니다. 프로젝트를 시작하는 순간에는 모든 것이 열려 있어 자유로우며, 그 자유가 새로운 도메인에 대한 탐구심을 자극하기 때문입니다. 그런 점에서 짧지만 굵게 새로운 것을 시도하고 배울 수 있는 기술 문서 컨설팅은 제게 참 신나는 업무입니다. 이번 글에서는 몇 달 전에 진행했던 API 문서화 컨설팅에서 배운 내용을 공유하려 합니다. 주제는 새로운 언어를 위한 소스 코드 주석 기반 API 문서화 도구 만들기입니다. 정확히 말하면 '도구 만들기'라기보다 '도구 찾아 적용하기'이므로, 코딩이 많이 필요할 거라는 기대 혹은 염려는 가슴 한편에 고이 접어둬도 좋습니다. 소스 코드 주석으로 남긴 API 설명을 자동으로 문서로 만드는 일은 흔하디흔합니다. 대표적인 예가 Javadoc이나 JSDoc과 같은 도구로, 흔히 쓰는 프로그래밍 언어에서는 대체로 이런 문서화 도구를 사용해 문서를
- Technical Writing
테크니컬 라이팅 컨퍼런스: API the Docs Chicago 2019 방문기
수J2019-08-09
LINE에서 즐겁게 일하고 있는 테크니컬 라이터입니다
미국에는 머스타드 박물관이 있다고 합니다. 무려 머스타드를 위한 박물관도 있는데! '헨리 밀러'나 '어니스트 헤밍웨이' 등 훌륭한 작가와 오랜 세월 전세계적으로 사랑받고 있는 작품을 쏟아낸 나라에 작가를 위한 박물관이 없다는 사실에 개탄을 금치 못한 사람들이 의기투합하여 2009년 재단을 설립하고 2017년, American Writers Museum(AWM)을 탄생시켰습니다. 그리고 바로 이 AWM이 위치한 시카고에서 API the Docs Chicago 컨퍼런스가 개최되었습니다. 그러고 보니 어니스트 헤밍웨이도 시카고 출신이네요(시카고 여행지 추천 목록에 헤밍웨이 생가가 있다는 사실!). 그동안 유럽에서만 개최되어 온 API the Docs가 처음으로 미국에서 개최된 것도 뜻깊은데 장소까지 테크니컬 '라이터'에게 의미있는 장소였던 이번 API the Docs Chicago에 참석하게 된 후기를 늦게나마 여러분과 나누고자 합니다. API the
- Technical Writing
문서 엔지니어링과 API 문서화
전정은2019-06-28
LINE에서 문서 솔루션 및 기술 문서 작성 기법을 고민하는 도큐먼트 엔지니어입니다.
이 글은 마이크로소프트웨어 396호에 기고된 글입니다. 들어가기 테크니컬 라이터(technical writer)라는 말을 들으면 대부분 '라이터'라는 단어만 보고 '글 쓰는 사람'이라 생각하기 십상입니다. 물론 틀린 것은 아니지만, 실상 키보드를 두드리며 글 쓰는 일이 테크니컬 라이터 업무의 대부분을 차지하지는 않습니다. 하루에 얼마 동안 글을 쓰는지 측정해 본 적은 없으나, 테크니컬 라이터 톰 존슨(Tom Johnson)이 말하기로는 일하는 시간의 약 10%라고 합니다. 그렇다면 그 밖의 시간에는 뭘 할까요? 역시 톰 존슨에 따르면 개발자 인터뷰, 다른 사람이 쓴 문서 리뷰, 앱 스크린 캐스팅이 필요할 때 아이폰 탈옥, 미디어위키에서 링크된 이미지에 캡션 넣는 방법 찾기 등등이라고 합니다. 그중에서도 제가 말하고자 하는 일은 비록 '아이폰 탈옥' 같은 건 아니지만 결과적으로는 글쓰기와는 전혀 관계 없어 보이는 엔지니어링에 관한
- Technical Writing
Technical Communication Symposium 2018 참석기 - 기술 문서의 번역 품질 평가 방법
김지현2019-01-22
LINE GAME PLATFORM 문서를 담당하는 테크니컬 라이터입니다.
안녕하세요. LINE GAME PLATFORM의 문서 제작과 배포를 담당하는 테크니컬 라이터 김지현입니다. LINE GAME PLATFORM은 한국과 일본, 두 거점에서 기획하고 개발하는 프로젝트인데요. 이에 맞춰 문서도 한국어와 일본어, 두 가지 언어로 작성하고 있습니다. 두 가지 언어로 글을 쓸 때 가장 어려운 점은 언어별로 독자의 지역적, 문화적 배경을 글에 녹여내야 한다는 것입니다. 저는 일본어로 글을 쓰는 게 어렵지는 않지만 모국어가 한국어고 한국에서 일하고 있기 때문에 일본 현지의 생생한 느낌까지 글로 옮기는 것에는 늘 부족함을 느끼고 있습니다. 그래서 나름대로 부족한 부분을 보완하고자 일본에서 열리는 컨퍼런스에 참석하고 있고, 작년에는 'TC(Technical Communication) Symposium 2018 in Tokyo'에 다녀왔습니다. 테크니컬 커뮤니케이터(Technical Communicat
- Event Report
- Technical Writing
글 잘 쓰고 싶은 LINE 개발자를 위한 행사, 'Technical Writing Day'에 다녀왔습니다
손근2018-12-04
LINE에서 테크니컬 라이터로 일하고 있습니다.
안녕하세요. 이번 글에서는 지난 11월 8일, 라인오피스에서 열렸던 'Technical Writing Day'에 대해 이야기해볼까 합니다. 이번 행사는 LINE 임직원들에게 테크니컬 라이팅에 대해 알리고자 LINE Technical Writing 팀에서 개최한 사내행사였습니다. 테크니컬 라이팅에 대한 소개와 함께, 논리적인 문서 구조를 만드는 방법과 바른 문장을 쓰는 방법, 한국어로 기술 문서를 작성하면서 국제화를 고려하는 방법, API 문서를 PDF나 웹페이지 등으로 만드는 방법 등 문서 작업 전반에 도움이 되는 여러 가지 방법과 노하우가 공유된 알찬 행사였다고 합니다. 그럼 각 세션에서 어떤 내용이 전달되었는지 사진과 함께 보시겠습니다. 행사 소개 행사는 총 6개의 세션이 회의실 세 곳에서 병렬로 진행되었습니다. 회의실 두 곳에선 교육이 진행되었고요. 나머지 한 곳에선 문서 컨설팅과 w
- Technical Writing
- LINE Events
테크니컬 라이팅 컨퍼런스: Write the Docs Prague 2018 방문기
강정일2018-10-03
LINE 기술 문서 작성 및 관리 업무를 맡고 있는 Technical Writer 강정일입니다.
안녕하세요. CLOVA 기술 문서 작성 및 관리 업무를 맡고 있는 Technical Writing 팀 강정일입니다. 제가 테크니컬 라이팅(Technical writing) 분야에서 일한 지 어느덧 10년 정도 되었습니다. 하지만 이 글을 보고 계신 분들 중 많은 분들이 테크니컬 라이팅이란 단어를 처음 듣거나, 들었어도 정확히 어떤 일을 하는 지는 잘 모르실 수도 있다고 생각합니다. 한국만 해도 대학에 테크니컬 라이팅과 관련된 전공이 없어서인지 이런 직무를 가진 분들을 만나는 게 쉽지 않습니다. 특히 한국 소프트웨어 산업의 특성 상, 설계 문서나 API 레퍼런스와 같은 기술 문서를 다루는 테크니컬 라이터를 만난다는 것이 더욱 어려운 일인 듯 합니다. 이런 척박한 환경에서 테크니컬 라이팅 분야에 대한 최신 뉴스나 업무에 대한 지식, 전략 등을 얻기 위해 대부분의 테크니컬 라이터들이 인터넷 검색이나 팀원 간의 정보나 경험 공유에 의존하고 있는데요. 이번에 Write the Docs 컨퍼런
- Technical Writing
API the Docs 참관 후기
Serizawa2018-05-29
LINE 플랫폼 개발자용 문서를 담당하고 있는 테크니컬 라이터입니다.
안녕하세요? 테크니컬 라이터 Serizawa입니다. LINE은 개발자들이 최신 기술 동향을 파악할 수 있도록 해외 컨퍼런스 참가를 지원합니다. 이번 포스팅에서는 제가 이 지원 제도를 이용해 다녀온 API 문서화 관련 컨퍼런스인 API the Docs에 대해 전해 드릴까 합니다. API the Docs는 테크니컬 라이터, API 개발자, 프로덕트 오너, 에반젤리스트를 대상으로 한 API 문서화에 특화된 행사로, 해마다 여러 차례, 세계 각지에서 열립니다. 개발 경험(Developer eXperience, 이하 'DX')의 중요 요소인 문서화에 관해서 최신 우수 사례나 경향 등을 공유하고 의견을 나누는 자리이지요. 이번 행사는 2018년 4월 24일, 파리 시내 중심부에 있는 Mozilla 사무실에서 열렸습니다. API 전문가, 콘텐츠 전략가, 소프트웨어 개발자 등 다양한 위치에서 API 문서 및 개발자 포털의 개발, 운영에 종사하는 분들께서 총 열 가지 테마로 강연을 진행해 주셨습니다
- Technical Writing

1 2